package pl.bigk.utils.lexengines.period;

public interface PeriodEngine {

	public static final int PERIOD_DAY = 1;
	public static final int PERIOD_MONTH = 2;
	public static final int PERIOD_YEAR = 3;

	/**
	 * Zwraca zrozumialy dla czlowieka opis w danym jezyku dla podanego okresu
	 * i czestotliwosci.
	 * <p>
	 * Przykladowo:
	 * <ul>
	 * 		<li>
	 * 			dla wartosci <code>period == PERIOD_DAY</code> i
	 * 			<code>frequency == 1</code> wynikiem bedzie <code>jeden dzien</code>.
	 * 		</li>
	 * 		<li>
	 * 			dla wartosci <code>period == PERIOD_DAY</code> i
	 * 			<code>frequency == 11</code> wynikiem bedzie <code>jedenascie dni</code>.
	 * 		</li>
	 * </ui>
	 * 
	 * @param period
	 *            okres, jedna z wartosci: {@link #PERIOD_DAY},
	 *            {@link #PERIOD_MONTH}, {@link #PERIOD_YEAR}
	 * @param frequency
	 *            czestotliwosc, liczba dni, miesiecy, lat
	 * @return opis zrozumialy dla czlowieka w danym jezyku
	 */
	public String getText(int period, int frequency);

}
